package com.sharing.util;

import java.util.HashMap;
import java.util.Map;

/**
 * @author MingTian
 * @version 1.0
 * @description
 * TODO 该类基于双向链表和哈希表实现一个简易版的LRU数据结构
 * TODO 该LRU数据结构名为 LRUCache，下述将介绍该数据结构的特点
 * TODO LRUCache(int capacity) 以 正整数 作为容量 capacity 初始化 LRU 缓存
 * TODO int get(int key) 如果关键字 key 存在于缓存中，则返回关键字的值，否则返回 -1
 * TODO void put(int key, int value) 如果关键字 key 已经存在，则变更其数据值 value
 * TODO 如果不存在，则向缓存中插入该组 key-value 。如果插入操作导致关键字数量超过 capacity ，则应该 逐出 最久未使用的关键字。
 * TODO 函数 get 和 put 必须以 O(1) 的平均时间复杂度运行
 * @date 2023/7/7 21:28
 */
public class LRUCache {
    /**
     * 内部类
     * 主要用于记录key以及前后指针的数据结构
     */
    class DLinkedNode {
        int key;
        int value;
        DLinkedNode prev;
        DLinkedNode next;
        public DLinkedNode() {}
        public DLinkedNode(int _key, int _value) {
            key = _key;
            value = _value;
        }
    }

    /**
     * LRUCache 内部内置一个 Map
     * 用于在 O(1) 的时间复杂度内查到 LRUCache 中是否已经存在
     */
    private Map<Integer, DLinkedNode> cache = new HashMap<Integer, DLinkedNode>();

    /**
     * 当前 LRUCache 内元素的数量
     */
    private int size;

    /**
     * LRUCache 最大容量
     */
    private int capacity;

    /**
     * LRU缓存本质上就是一个特殊的双向链表
     * head: 头指针
     * tail: 尾指针
     */
    private DLinkedNode head, tail;

    /**
     * 构造方法
     * @param capacity
     */
    public LRUCache(int capacity) {
        this.size = 0;
        this.capacity = capacity;
        // 使用伪头部和伪尾部节点
        head = new DLinkedNode();
        tail = new DLinkedNode();
        head.next = tail;
        tail.prev = head;
    }

    /**
     * 查询 key 是否存在
     * @param key
     * @return
     */
    public int get(int key) {
        DLinkedNode node = cache.get(key);
        if (node == null) {
            return -1;
        }
        // 如果 key 存在，先通过哈希表定位，再移到头部
        moveToHead(node);
        return node.value;
    }

    /**
     * 新增 key-value
     * @param key
     * @param value
     */
    public void put(int key, int value) {
        DLinkedNode node = cache.get(key);
        if (node == null) {
            // 如果 key 不存在，创建一个新的节点
            DLinkedNode newNode = new DLinkedNode(key, value);
            // 添加进哈希表
            cache.put(key, newNode);
            // 添加至双向链表的头部
            addToHead(newNode);
            ++size;
            if (size > capacity) {
                // 如果超出容量，删除双向链表的尾部节点
                DLinkedNode tail = removeTail();
                // 删除哈希表中对应的项
                cache.remove(tail.key);
                --size;
            }
        }
        else {
            // 如果 key 存在，先通过哈希表定位，再修改 value，并移到头部
            node.value = value;
            moveToHead(node);
        }
    }

    /**
     * 将节点加到头部
     * @param node
     */
    private void addToHead(DLinkedNode node) {
        node.prev = head;
        node.next = head.next;
        head.next.prev = node;
        head.next = node;
    }

    /**
     * 删除某个节点
     * @param node
     */
    private void removeNode(DLinkedNode node) {
        node.prev.next = node.next;
        node.next.prev = node.prev;
    }

    /**
     * 将一个已存在的节点移动到头部
     * @param node
     */
    private void moveToHead(DLinkedNode node) {
        removeNode(node);
        addToHead(node);
    }

    /**
     * 删除尾节点
     * @return
     */
    private DLinkedNode removeTail() {
        DLinkedNode res = tail.prev;
        removeNode(res);
        return res;
    }
}
